\input texinfo @c -*- texinfo -*-

@c %**start of header
@setfilename textstream.info
@settitle textstream Manual @value{VERSION}
@c %**end of header

@include version.texi

@syncodeindex fn cp
@syncodeindex vr cp

@dircategory Libraries
@direntry
* textstream: (textstream).     A library for rendering autoscrolling text.
@end direntry

@copying
This is the manual for textstream version @value{VERSION}, a library for
rendering autoscrolling text surfaces in SDL.

Copyright @copyright{} 2011 Jack Kelly.

@quotation
This manual is free documentation: it is available under the Creative
Commons Attribution Share-Alike license version 3.0 available at
@indicateurl{http://creativecommons.org/licenses/by-sa/3.0}.
@end quotation
@end copying

@titlepage
@title textstream Manual @value{VERSION}

@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@contents

@ifnottex
@node Top
@top textstream

@insertcopying
@end ifnottex

@menu
* Concept:: The basic idea.
* API:: Types and functions.

* Index:: Functions and concepts defined by textstream.
@end menu

@node Concept
@chapter Concept

textstream provides portable routines for streaming text to an
autoscrolling window, updating the window one character at a time. The
result is like Hacker Typer @indicateurl{http://hackertyper.net}.

@include textstream-api.texi

@node Index
@unnumbered Index

@printindex cp

@bye
